feat(core): Add compatibility to redis > 6 ACLs system using username in queue-mode #5048

intel44 · 2022-12-28T16:06:07Z

Github issue / Community forum post (link here to close automatically): https://community.n8n.io/t/add-a-configuration-variable-for-the-redis-username-queue-mode/15878

CLAassistant · 2022-12-28T16:06:12Z

All committers have signed the CLA.

packages/cli/src/Queue.ts

netroy · 2022-12-28T16:39:02Z

@intel44 Have you tested this in the queue mode?
I assume that we need to update ioredis to 4.x or 5.x to be able to use any new redis features.

intel44 · 2022-12-28T22:21:09Z

Hi @netroy, thanks for your feedback.

Have you tested this in the queue mode?
I assume that we need to update ioredis to 4.x or 5.x to be able to use any new redis features.

After verification, no need to update any package. The current versions are fully compatible without adjustment.

Current packages :

packages/cli :
- [email protected]
- [email protected]
  - including [email protected]

The authentication feature has been include to [email protected] : redis/ioredis#1130

Some tests to ensure compatibility

Config

My redis users for tests :

$ redis-cli
127.0.0.1:6379> acl list
1) "user default on nopass ~* &* +@all"
2) "user user-with-password on #a1159e9df3670d549d04524532629f5477ceb7deec9b45e47e8c009506ecb2c8 ~* &* +@all"
3) "user user-without-password on nopass ~* &* +@all"

Tests

I added a log of redisConfig in Queue.js to show the config used in queue mode.

Default mode

$ pnpm worker

> [email protected] worker /var/www/n8n
> ./packages/cli/bin/n8n worker

Starting n8n worker...
{ host: 'localhost', port: 6379, db: 80 }

n8n worker is now ready
 * Version: 0.209.3
 * Concurrency: 10

Specific user without password

$ export QUEUE_BULL_REDIS_USERNAME=user-without-password 
$ pnpm worker

> [email protected] worker /var/www/n8n
> ./packages/cli/bin/n8n worker

Starting n8n worker...
{
  host: 'localhost',
  username: 'user-without-password',
  port: 6379,
  db: 80
}

n8n worker is now ready
 * Version: 0.209.3
 * Concurrency: 10

Specific user with password

$ export QUEUE_BULL_REDIS_USERNAME=user-with-password 
$ export QUEUE_BULL_REDIS_PASSWORD=pwd
$ pnpm worker

> [email protected] worker /var/www/n8n
> ./packages/cli/bin/n8n worker

Starting n8n worker...
{
  host: 'localhost',
  username: 'user-with-password',
  password: 'pwd',
  port: 6379,
  db: 80
}

n8n worker is now ready
 * Version: 0.209.3
 * Concurrency: 10

Rotten case : Specific user with bad password

$ export QUEUE_BULL_REDIS_PASSWORD=pwdbad
$ pnpm worker

> [email protected] worker /var/www/n8n
> ./packages/cli/bin/n8n worker

Starting n8n worker...
{
  host: 'localhost',
  username: 'user-with-password',
  password: 'pwdbad',
  port: 6379,
  db: 80
}

n8n worker is now ready
 * Version: 0.209.3
 * Concurrency: 10

Error from queue: 

/var/www/n8n/node_modules/.pnpm/[email protected]/node_modules/redis-parser/lib/parser.js:179
    return new ReplyError(string)
           ^
ReplyError: WRONGPASS invalid username-password pair or user is disabled.
    at parseError (/var/www/n8n/node_modules/.pnpm/[email protected]/node_modules/redis-parser/lib/parser.js:179:12)
    at parseType (/var/www/n8n/node_modules/.pnpm/[email protected]/node_modules/redis-parser/lib/parser.js:302:14)
 ELIFECYCLE  Command failed with exit code 1.

Rotten case : Unknow user

$ export QUEUE_BULL_REDIS_USERNAME=user-unknow          
$ pnpm worker

> [email protected] worker /var/www/n8n
> ./packages/cli/bin/n8n worker

Starting n8n worker...
{ host: 'localhost', username: 'user-unknow', port: 6379, db: 80 }

n8n worker is now ready
 * Version: 0.209.3
 * Concurrency: 10

Error from queue: 

/var/www/n8n/node_modules/.pnpm/[email protected]/node_modules/redis-parser/lib/parser.js:179
    return new ReplyError(string)
           ^
ReplyError: WRONGPASS invalid username-password pair or user is disabled.
    at parseError (/var/www/n8n/node_modules/.pnpm/[email protected]/node_modules/redis-parser/lib/parser.js:179:12)
    at parseType (/var/www/n8n/node_modules/.pnpm/[email protected]/node_modules/redis-parser/lib/parser.js:302:14)
 ELIFECYCLE  Command failed with exit code 1.

StarfallProjects · 2023-01-03T10:03:55Z

If/when this gets merged, can someone either give me a heads-up, or also merge the related docs PR? n8n-io/n8n-docs#1055 (and check it's still correct, if there are further code changes)

…acl-compatibility

netroy · 2023-01-03T11:52:42Z

@StarfallProjects both PRs merged

intel44 · 2023-01-03T13:10:12Z

packages/cli/src/Queue.ts

-		if (redisDB) {
-			redisOptions.db = redisDB;
-		}
+		const redisOptions: RedisOptions = config.getEnv('queue.bull.redis');


Hi @netroy
With this commit, you remove my modifications: when the variable QUEUE_BULL_REDIS_USERNAME is not set, it will send username: ''
Is this going to be a problem ?

It didn't seem to be an issue when I tested it on redis 5 and 6.

janober · 2023-01-05T15:40:28Z

Got released with [email protected]

n8n-assistant bot added community Authored by a community member core Enhancement outside /nodes-base and /editor-ui labels Dec 28, 2022

netroy reviewed Dec 28, 2022

View reviewed changes

packages/cli/src/Queue.ts Outdated Show resolved Hide resolved

intel44 mentioned this pull request Dec 28, 2022

docs(env-var): add new var QUEUE_BULL_REDIS_USERNAME n8n-io/n8n-docs#1055

Merged

feat(redis): add compatibility to redis > 6 ACLs system using username

77e29ff

intel44 force-pushed the redis-add-username-acl-compatibility branch from 0495bf9 to 77e29ff Compare December 28, 2022 23:18

intel44 changed the title ~~feat(redis): add compatibility to redis > 6 ACLs system using username~~ feat(cli): add compatibility to redis > 6 ACLs system using username in queue-mode Dec 29, 2022

Merge remote-tracking branch 'origin/master' into redis-add-username-…

5a0be67

…acl-compatibility

netroy changed the title ~~feat(cli): add compatibility to redis > 6 ACLs system using username in queue-mode~~ feat(core): Add compatibility to redis > 6 ACLs system using username in queue-mode Jan 3, 2023

netroy approved these changes Jan 3, 2023

View reviewed changes

netroy merged commit 0ec66bf into n8n-io:master Jan 3, 2023

netroy added the Upcoming Release Will be part of the upcoming release label Jan 3, 2023

intel44 commented Jan 3, 2023

View reviewed changes

janober removed the Upcoming Release Will be part of the upcoming release label Jan 5, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(core): Add compatibility to redis > 6 ACLs system using username in queue-mode #5048

feat(core): Add compatibility to redis > 6 ACLs system using username in queue-mode #5048

intel44 commented Dec 28, 2022

CLAassistant commented Dec 28, 2022 •

edited

Loading

netroy commented Dec 28, 2022

intel44 commented Dec 28, 2022

StarfallProjects commented Jan 3, 2023

netroy commented Jan 3, 2023

intel44 Jan 3, 2023

netroy Jan 3, 2023 •

edited

Loading

janober commented Jan 5, 2023

feat(core): Add compatibility to redis > 6 ACLs system using username in queue-mode #5048

feat(core): Add compatibility to redis > 6 ACLs system using username in queue-mode #5048

Conversation

intel44 commented Dec 28, 2022

CLAassistant commented Dec 28, 2022 • edited Loading

netroy commented Dec 28, 2022

intel44 commented Dec 28, 2022

Some tests to ensure compatibility

Config

Tests

Default mode

Specific user without password

Specific user with password

Rotten case : Specific user with bad password

Rotten case : Unknow user

StarfallProjects commented Jan 3, 2023

netroy commented Jan 3, 2023

intel44 Jan 3, 2023

Choose a reason for hiding this comment

netroy Jan 3, 2023 • edited Loading

Choose a reason for hiding this comment

janober commented Jan 5, 2023

CLAassistant commented Dec 28, 2022 •

edited

Loading

netroy Jan 3, 2023 •

edited

Loading